Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ignore path doc: double escape to add escape character in rst #7217

Merged
merged 1 commit into from
Nov 9, 2022
Merged

Ignore path doc: double escape to add escape character in rst #7217

merged 1 commit into from
Nov 9, 2022

Conversation

tbennett0
Copy link
Contributor

Adding another escape to small doc PR submitted in #7103, looks like the autoupgrade removed the escape.

CC @Pierre-Sassoulas

@tbennett0 tbennett0 changed the title Double escape to put escape character in rst Ignore path doc: double escape to add escape character in rst Jul 21, 2022
@coveralls
Copy link

coveralls commented Jul 21, 2022 •
edited
Loading

Pull Request Test Coverage Report for Build 3431238808

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 419 unchanged lines in 40 files lost coverage.
  • Overall coverage increased (+0.1%) to 95.388%
Files with Coverage Reduction New Missed Lines %
pylint/config/arguments_provider.py 1 94.87%
pylint/extensions/code_style.py 1 99.15%
pylint/lint/parallel.py 1 94.12%
pylint/message/message_definition_store.py 1 98.33%
pylint/message/message.py 1 95.56%
pylint/reporters/multi_reporter.py 1 98.21%
pylint/testutils/_primer/primer_command.py 1 95.65%
pylint/utils/pragma_parser.py 1 98.25%
pylint/checkers/modified_iterating_checker.py 2 97.8%
pylint/epylint.py 2 83.33%
Totals Coverage Status
Change from base Build 2711986983: 0.1%
Covered Lines: 17250
Relevant Lines: 18084
💛 - Coveralls

@github-actions

This comment has been minimized.

Sign in to view
@Pierre-Sassoulas Pierre-Sassoulas added Documentation 📗 Skip news 🔇 This change does not require a changelog entry labels Jul 22, 2022
Pierre-Sassoulas
Pierre-Sassoulas reviewed Jul 24, 2022
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you ! It took my waaaay longer than I'd like to admit to find the result in read the doc.

This fix the issue in the online documentation but it's very likely that the text is also used on the help text of the command line tool. Could we add a test to check that the command line tool's help still make sense ?

@tbennett0
Copy link
Contributor Author

Sure, I'll look into it 👍

@DanielNoord DanielNoord closed this Nov 9, 2022
@DanielNoord DanielNoord reopened this Nov 9, 2022
DanielNoord
DanielNoord approved these changes Nov 9, 2022
View reviewed changes
Copy link
Collaborator

@DanielNoord DanielNoord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just merge, seems like a good improvement. If somebody wants to fix the CLI they can provide a fix afterwards, online documentation is probably used way more often.
Even I forget we have a CLI tool for help messages sometimes.. 😅

Pierre-Sassoulas
Pierre-Sassoulas approved these changes Nov 9, 2022
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough.

@DanielNoord DanielNoord enabled auto-merge (rebase) November 9, 2022 19:48
@DanielNoord DanielNoord merged commit 0e3a0da into pylint-dev:main Nov 9, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 9, 2022

🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉

This comment was generated for commit 9ff5f70

@tbennett0
Copy link
Contributor Author

Ah. I apologize, I didn't get the chance to take this up. I'll take a deeper look soon.

@tbennett0 tbennett0 deleted the patch-1 branch November 9, 2022 20:29
@Pierre-Sassoulas
Copy link
Member

Don't worry @tbennett0, Daniel is right I was nitpicking. Don't worry there's a lot of pylint issues to handle if you feel like it 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DanielNoord DanielNoord DanielNoord approved these changes

@Pierre-Sassoulas Pierre-Sassoulas Pierre-Sassoulas approved these changes

Assignees
No one assigned
Labels
Documentation 📗 Skip news 🔇 This change does not require a changelog entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tbennett0 @coveralls @Pierre-Sassoulas @DanielNoord